GET
/
v1
/
custom_fields
curl --request GET \
  --url https://api.rootly.com/v1/custom_fields \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "custom_fields",
      "attributes": {
        "label": "<string>",
        "kind": "<string>",
        "enabled": true,
        "slug": "<string>",
        "description": "<string>",
        "shown": [
          "incident_form"
        ],
        "required": [
          "incident_form"
        ],
        "default": "<string>",
        "position": 123,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
enum<string>

comma separated if needed. eg: options

Available options:
options
​
sort
enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
position,
-position
​
page[number]
integer
​
page[size]
integer
​
filter[slug]
string
​
filter[label]
string
​
filter[kind]
string
​
filter[enabled]
boolean
​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string

Response

200 - application/vnd.api+json
success
​
data
object[]
required
​
links
object
required

Was this page helpful?